Conversation
nedseb
left a comment
nedseb
left a comment
There was a problem hiding this comment.
C'est la meilleure PR jusqu'ici — l'API Reference est complète et la structure est claire. Quelques ajustements mineurs :
Cohérence avec les autres README
-
Section I²C Address — Le bloc de code avec juste
0x29est disproportionné (même remarque que sur les autres PR). Une ligne "Default I²C address:0x29" suffit, ou remets-le dans le tableau des specs. -
Phrase d'intro vague — "This library is a port of the original MicroPython VL53L1X driver." → le lien source est tout en bas. Mets-le directement ici : "This library is a port of vl53l1x_pico." et supprime la section Source en bas.
Précision du contenu
-
reset()— "software reset" — Le driver fait un write à 0x00 puis 0x01 sur le registre SOFT_RESET avec unlightsleep(100)entre les deux. Précise que le reset prend ~100ms. -
Specs approximatives — "± few mm (typical)" et "~27°" sont vagues. Si tu ne trouves pas les valeurs exactes dans la datasheet, c'est OK de les laisser mais remplace "± few mm" par "± 3% (typical)" qui est plus proche de la réalité.
-
Note sur l'erreur d'init — "raises an error if the sensor is not detected" → précise le type d'erreur pour que ce soit actionable.
-
Trailing whitespace — Ligne "This library is a port..." a un espace en fin de ligne.
Corrige ces points et c'est bon à merger.
There was a problem hiding this comment.
Pull request overview
Expands the vl53l1x driver README to match the documentation depth and structure used by other drivers in this repository.
Changes:
- Adds feature list, sensor specification summary, and default I2C address section.
- Adds a basic usage snippet and documents the public API surface (measurement, ranging, power/device control).
- Adds an examples section and operational notes (init delay, device ID check).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Feature | Value | | ||
| | ------------- | -------------------- | | ||
| | Technology | Time-of-Flight (ToF) | |
There was a problem hiding this comment.
The Sensor Specifications table uses || at the start of each row (e.g., || Feature | Value |), which renders as an extra empty column (or can break table rendering depending on the Markdown renderer). Use a single leading | for each row so the table formats correctly.
| | File | Description | | ||
| | ----------- | -------------------------- | | ||
| | distance.py | Basic distance measurement | | ||
|
|
There was a problem hiding this comment.
The Examples table also starts rows with || (double pipe), which produces an empty first column / malformed table. Switch to single leading | for proper Markdown table formatting.
|
README réécrit en 29162fe pour traiter tous les commentaires : Revue :
Copilot :
Prête à merger. |
|
🎉 This PR is included in version 0.0.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Closes #193
Parent issue #194
Description
Expand VL53L1X README to match other drivers documentation level.
Changes
Checklist